Add instructions to run tests + build docs locally #44
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
Codecov Report
@@ Coverage Diff @@
## main #44 +/- ##
=======================================
Coverage 10.72% 10.72%
=======================================
Files 2 2
Lines 429 429
=======================================
Hits 46 46
Misses 383 383 |
|
I admit I didn't try the pip version. But the conda version worked for me! |
…A/mom6-regional into ncc/add-instructions-to-build-docs
navidcy
changed the title
ashjbarnes
approved these changes
Jun 22, 2023
angus-g
reviewed
Jun 22, 2023
|
|
||
| ```{code-block} bash | ||
| cd docs | ||
| pip install -r docs/requirements.txt |
There was a problem hiding this comment.
This won't work, would be just pip install -r requirements.txt since you changed into docs in the previous line.
|
I'll fix it! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a section in the docs to explain how contributors can:
https://mom6-regional--44.org.readthedocs.build/en/44/contributing.html